Add contribution guidelines for pull requests to copilot review#1053
Add contribution guidelines for pull requests to copilot review#1053
Conversation
Added guidelines for reviewing PRs with copilot.
There was a problem hiding this comment.
Pull request overview
This PR adds contribution guidelines for automated PR reviews by GitHub Copilot. The new .github/copilot-instructions.md file provides a streamlined checklist based on the existing pull request template, focusing on the essential review criteria for change notes and query development.
Changes:
- Added
.github/copilot-instructions.mdcontaining guidelines for Copilot to review pull requests, including change note requirements and query development checklist items
Comments suppressed due to low confidence (1)
.github/copilot-instructions.md:20
- The original PR template includes two important checklist items that are missing from this file: "Have you considered/identified possible edge cases?" and "Have you run the queries on OpenPilot and verified that the performance and results are acceptable?" (with the 1 minute/10 seconds guideline). These items are important quality checks that should be retained in the Copilot review guidelines.
For PRs that add new queries or modify existing queries, also consider the following review checklist:
- Confirm that the output format of shared queries is valid.
- Have all the relevant rule package description files been checked in?
- Have you verified that the metadata properties of each new query is set appropriately?
- Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
- Are all the alerts in the expected file annotated as NON_COMPLIANT in the test source file?
- Are the alert messages properly formatted and consistent with the style guide?
- Does the query have an appropriate level of in-query comments/documentation?
- Does the query not reinvent features in the standard library?
- Can the query be simplified further (not golfed!)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Clarified the requirement for change notes in pull requests and updated wording for reporting checks.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
MichaelRFairhurst
left a comment
MichaelRFairhurst
left a comment
There was a problem hiding this comment.
This is fantastic Mauro, thanks for thinking of and taking the initiative on this!!
|
I had too much fun with this idea 😂 Feel free to just plain ship it!! 🚀 |
Co-authored-by: Michael R Fairhurst <MichaelRFairhurst@github.com>
Co-authored-by: Michael R Fairhurst <MichaelRFairhurst@github.com>
2 participants
Added guidelines for reviewing PRs with copilot.
Description
Adds guidelines for Copilot code review, based on the existing checklist
Change request type
.ql,.qll,.qlsor unit tests)Rules with added or modified queries
Release change checklist
A change note (development_handbook.md#change-notes) is required for any pull request which modifies:
If you are only adding new rule queries, a change note is not required.
Author: Is a change note required?
🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.
Reviewer: Confirm that either a change note is not required or the change note is required and has been added.
Query development review checklist
For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:
Author
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
Reviewer
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.